/*
 * The contents of this web application are subject to the Mozilla Public License Version 
 * 1.1 (the "License"); you may not use this web application except in compliance with 
 * the License. You may obtain a copy of the License at http://www.mozilla.org/MPL/.
 * 
 * Software distributed under the License is distributed on an "AS IS" basis, 
 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 
 * for the specific language governing rights and limitations under the License.
 * 
 * The Original Code is owned by and the Initial Developer of the Original Code is 
 * Composite A/S (Danish business reg.no. 21744409). All Rights Reserved
 * 
 * Section 11 of the License is EXPRESSLY amended to include a provision stating 
 * that any dispute, including but not limited to disputes related to the enforcement 
 * of the License, to which Composite A/S as owner of the Original Code, as Initial 
 * Developer or in any other role, becomes a part to shall be governed by Danish law 
 * and be initiated before the Copenhagen City Court ("K�benhavns Byret")            
 */

using Composite.Data.Types;


namespace Composite.Data.Plugins.DataProvider
{
    /// <summary>    
    /// This should be implemented by DataProviders that provies IFile data items.    
    /// </summary>
    /// <exclude />
    [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]
    public interface IFileSystemDataProvider : IDataProvider
    {
        /// <summary>
        /// This method is called when the absolute file path needs validation.
        /// Only the data provider knows the base path, so its responsible for 
        /// creating the full absolute path from an IFile.
        /// </summary>
        /// <typeparam name="TFile">An IFile or an sub interface</typeparam>
        /// <param name="file">The IFile instance</param>
        /// <param name="errorMessage">Will contain the error message, if any</param>
        /// <returns>Returns false if something is wrong with the path and <paramref name="errorMessage"/> will contain the error message. Otherwice true.</returns>
        bool ValidatePath<TFile>(TFile file, out string errorMessage) where TFile : IFile;
    }
}
